/*
 * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
 *
 * Copyright (C) 2021 Tencent.  All rights reserved.
 *
 * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
 *
 * A copy of the MIT License is included in this file.
 *
 *
 * Terms of the MIT License:
 * ---------------------------------------------------
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.tencent.bkrepo.repository.job.base

import com.tencent.bkrepo.common.api.util.HumanReadable
import com.tencent.bkrepo.common.api.util.executeAndMeasureTime
import com.tencent.bkrepo.common.service.log.LoggerHolder
import com.tencent.bkrepo.common.metadata.config.RepositoryProperties
import org.springframework.beans.factory.annotation.Autowired

/**
 * 支持动态开关的任务
 */
abstract class SwitchableJob : AsyncRepoJob {

    @Autowired
    lateinit var repositoryProperties: RepositoryProperties

    /**
     * 触发任务入口
     */
    open fun start() {
        if (!shouldExecute()) {
            return
        }
        executeAndMeasureTime { triggerJob() }.apply {
            if (first) {
                val elapsedTime = HumanReadable.time(second.toNanos())
                logger.info("Job[${getJobName()}] execution completed, elapse $elapsedTime.")
            }
        }
    }

    /**
     * 触发任务逻辑
     * @return 是执行
     */
    open fun triggerJob(): Boolean {
        logger.info("Start to execute async job[${getJobName()}]")
        run()
        return true
    }

    /**
     * 判断当前节点是否执行该任务
     */
    open fun shouldExecute(): Boolean {
        return repositoryProperties.job.enabled
    }

    /**
     * 返回任务名称
     */
    open fun getJobName(): String = javaClass.simpleName

    companion object {
        private val logger = LoggerHolder.jobLogger
    }
}
